---
layout: "default"
title: "UnicodeDecodingResult"
description: "Swift documentation for 'UnicodeDecodingResult': The result of one Unicode decoding step."
keywords: "UnicodeDecodingResult,enum,swift,documentation,=="
root: "/v3.1"
---

<div class="intro-declaration"><code class="language-swift">enum UnicodeDecodingResult</code></div>

<div class="discussion comment">
    <p>The result of one Unicode decoding step.</p>

<p>Each <code>UnicodeDecodingResult</code> instance can represent a Unicode scalar value,
an indication that no more Unicode scalars are available, or an indication
of a decoding error.</p>

<p><strong>See Also:</strong> <code>UnicodeCodec.decode(next:)</code></p>
</div>

<table class="standard">
<tr>
<th id="inheritance">Inheritance</th>
<td>
<code class="inherits">Equatable</code>
<span class="viz"><a href="hierarchy/">View Protocol Hierarchy &rarr;</a></span>
</td>
</tr>



<tr>
<th>Import</th>
<td><code class="language-swift">import Swift</code></td>
</tr>

</table>

<h3 id="cases">Cases</h3>
<div class="declaration" id="case-scalarValue">
<a class="toggle-link" data-toggle="collapse" href="#comment-case-scalarValue">case scalarValue(UnicodeScalar)</a>
<div class="comment collapse" id="comment-case-scalarValue"><div class="p">
    <p>A decoded Unicode scalar value.</p>

    <h4>Declaration</h4>    
    <code class="language-swift"></code>
</div></div>
</div>
<div class="declaration" id="case-emptyInput">
<a class="toggle-link" data-toggle="collapse" href="#comment-case-emptyInput">case emptyInput</a>
<div class="comment collapse" id="comment-case-emptyInput"><div class="p">
    <p>An indication that no more Unicode scalars are available in the input.</p>

    <h4>Declaration</h4>    
    <code class="language-swift"></code>
</div></div>
</div>
<div class="declaration" id="case-error">
<a class="toggle-link" data-toggle="collapse" href="#comment-case-error">case error</a>
<div class="comment collapse" id="comment-case-error"><div class="p">
    <p>An indication of a decoding error.</p>

    <h4>Declaration</h4>    
    <code class="language-swift"></code>
</div></div>
</div>






<h3>Instance Methods</h3>
<div class="declaration" id="func-eqeq_rhs_">
<a class="toggle-link" data-toggle="collapse" href="#comment-func-eqeq_rhs_">func ==(<wbr>_:<wbr>rhs:)</a>
        
<div class="comment collapse" id="comment-func-eqeq_rhs_"><div class="p">
    <p>Returns a Boolean value indicating whether two values are equal.</p>

<p>Equality is the inverse of inequality. For any values <code>a</code> and <code>b</code>,
<code>a == b</code> implies that <code>a != b</code> is <code>false</code>.</p>

<p><strong>Parameters:</strong>
  <strong>lhs:</strong> A value to compare.
  <strong>rhs:</strong> Another value to compare.</p>

    <h4>Declaration</h4>    
    <code class="language-swift">func ==(lhs: UnicodeDecodingResult, rhs: UnicodeDecodingResult) -&gt; Bool</code>
    
    
</div></div>
</div>


